Skip to content

Add check for parameter yaml to ensure consistence with source#7592

Open
Cstandardlib wants to merge 7 commits into
deepmodeling:developfrom
Cstandardlib:docs/yml
Open

Add check for parameter yaml to ensure consistence with source#7592
Cstandardlib wants to merge 7 commits into
deepmodeling:developfrom
Cstandardlib:docs/yml

Conversation

@Cstandardlib

Copy link
Copy Markdown
Collaborator

Linked Issue

Fix #7590

What's changed?

  • Add workflow to ensure parameter yaml file is up to date with source.

Copilot AI review requested due to automatic review settings July 4, 2026 11:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses #7590 by adding a CI guardrail that verifies the committed docs/parameters.yaml matches the parameter metadata embedded in the C++ source, preventing the docs from drifting when INPUT parameters change.

Changes:

  • Adds a GitHub Actions step that runs abacus_* --generate-parameters-yaml and diffs the output against docs/parameters.yaml.
  • Emits a clear failure message with regeneration instructions and prints a diff on mismatch.

@Growl1234

Copy link
Copy Markdown

How about adding it to "Integration test" instead?

@Cstandardlib

Copy link
Copy Markdown
Collaborator Author

How about adding it to "Integration test" instead?

Thanks, I will add it to an integration test.

@mohanchen mohanchen added the Compile & CICD & Docs & Dependencies Issues related to compiling ABACUS label Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Compile & CICD & Docs & Dependencies Issues related to compiling ABACUS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs lags behind the source code

4 participants